配置

配置文件路径

  • Windows

    在探针安装路径下"TingYun.ini"。安装路径通常在“C:\Program Files (x86)\Networkbench.COM\NetCore Profiler”下。

  • Linux

    在探针安装路径下"./lib/tingyun-dotnet/TingYun.ini"。

    • root安装: 安装路径在"/usr/"。
    • 非root安装: 安装路径在用户自己指定的文件夹。

license管理

nbs.license：与您的账号关联。探针采集到的数据，会上传到license key绑定的账号下。

应用命名

默认情况下，在报表展示的应用名称为.NET Core 的项目名称。

如果您想将应用命名为其他内容，请首先设置环境变量 TINGYUN_APP_NAME ，然后再启用探针。

Windows下命名

set TINGYUN_APP_NAME=custom_name 
call 安装路径\tingyun-enable.bat

Linux下命名

export TINGYUN_APP_NAME=custom_name 
. 安装路径/bin/tingyun-enable

日志管理

日志文件路径

  • Windows下日志文件路径在探针安装路径下log文件夹。安装路径通常在“C:\Program Files (x86)\Networkbench.COM\NetCore Profiler”下。

  • Linux下日志文件路径依赖于安装权限。

    • root安装：安装路径在"/var/log/tingyun/"。
    • 非root安装：安装路径在用户自己指定的文件夹"/安装路径/log/"。

日志级别

nbs.agent_log_level=INFO

取值: "OFF", "CRITICAL", "ERROR", "WARNING", "INFO", "VERBOSE", "DEBUG"。

本选项是控制日志数据写入日志文件的级别。"DEBUG"是最低级，允许所有日志信息写入日志文件。"OFF"是最高级，禁止所有日志信息写入日志文件。

审计模式

nbs.audit_mode=false

取值: true / false。

本选项设定是否在日志文件中写入所有向基调听云平台上传和下载的数据内容。

用户溯源

支持从自定义嵌码的参数或返回值、HTTP request header、HTTP response header、URL参数、正文Form表单、Session、Cookie中获取用户信息。

日志溯源

必要条件

  • 探针 3.3.2.0 及以上版本
  • log4net 2.0.8 及以上版本
  • 基调听云平台内开启应用的“日志溯源”开关
  • 配置被监控应用的log4net配置文件

配置log4net

在conversionPattern内增加 [%property{TINGYUN}]。

生成的日志包括：

  • tingyun.app_id：应用与微服务为每一个监控的应用生成的唯一id。

  • tingyun.trace_id：在整个请求链路中，入口事务生成的整个请求链路的唯一标识，此值将在链路中不断传递到链路中的每一个请求（如果遇到无法实现跨应用追踪的组件的情况除外），以实现全链路追踪。调用链所涉及的各个应用的日志都显示同一个tingyun.trace_id。

  • tingyun.span_id：整个请求链路中，应用与微服务为所涉及的各个应用的请求单独生成的标识，应用日志中每个请求都显示不同的tingyun.span_id。

配置举例

请根据实际应用变通配置。

例如原配置为：

<log4net>
    <appender name="RollingFile" type="log4net.Appender.RollingFileAppender">
        <file value="g:\tmp\async-mvc.log" />
        <appendToFile value="true" />
        <param name="Encoding" value="UTF-8"/>
        <maximumFileSize value="100KB" />
        <maxSizeRollBackups value="2" />
        <layout type="log4net.Layout.PatternLayout">
            <conversionPattern value="%d [%-5p] [%t] [%c] %m %n" />
        </layout>
    </appender>
    <root>
        <level value="ALL" />
        <appender-ref ref="RollingFile" />
    </root>
</log4net>

可以将conversionPattern变更为：

<conversionPattern value="%d [%-5p] [%t] [%c] [%property{TINGYUN}] %m %n" />

产生的日志效果如下：

2021-12-29 14:27:18,278 [INFO ] [7] [Test] 
[tingyun.app_id:6318,tingyun.trace_id:74a09a3218129fa3,tingyun.span_id:74a09a3218129fa3] this is a message

results matching ""

    No results matching ""